Skip to content

Comments

chore: gradle asciidoc 설정 변경#56

Merged
hisonghy merged 1 commit intodevelopfrom
chore/asciidoc-config-55
Mar 26, 2025
Merged

chore: gradle asciidoc 설정 변경#56
hisonghy merged 1 commit intodevelopfrom
chore/asciidoc-config-55

Conversation

@hisonghy
Copy link
Member

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • index.adoc 파일에서 user.adoc , auth.adoc 파일은 잘 읽어오는데 각 도메인 adoc 파일에서 테스트 기반으로 생기는 스니펫 adoc 파일을 불러오지 못하는 문제가 발생
  • 각 도메인 adoc 파일의 snippetsDir 변수에 경로가 없어서 snippet 파일을 못 불러오고 상대경로 include 가 어긋나있어 문제가 발생했고, gradle의 asciidoctor 태스크에 snippetsDir 변수를 정의하고 baseDirFollowsSourceFile() 설정을 추가해 개별 adoc 파일의 위치를 기준으로 경로를 계산하도록해 상대경로를 읽을 수 있도록 함

🔍 참고사항

  • 직관적인 네이밍을 위해 user.adoc -> user-api.adoc , auth.adoc -> auth-api.adoc 으로 네이밍 수정

📚 기타

@hisonghy hisonghy added 📄 documentation 문서 작업 ⚙️ chore 빌드 및 CI/CD, 그외 설정작업 labels Mar 26, 2025
@hisonghy hisonghy requested a review from myqewr March 26, 2025 10:49
@hisonghy hisonghy self-assigned this Mar 26, 2025
@hisonghy hisonghy merged commit 1137ca1 into develop Mar 26, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

⚙️ chore 빌드 및 CI/CD, 그외 설정작업 📄 documentation 문서 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📄 rest docs adoc 경로 문제로 asciidoc 설정 수정

2 participants